Get person document by ID
GET /api/v1/PersonDocuments/:id/get
Description:
This endpoint is used to retrieve a person document by its unique ID.
Method:
GET
Tags:
PersonDocuments
URL:
/api/v{version}/PersonDocuments/{id}/get
ApiKey:
No API key required
Content-Type:
application/json
Query Parameters:
None
Path Parameters:
-
version (string, required): The API version.
-
id (string, required): The ID of the document to be retrieved.
Request Body:
None
Response:
Success, returns the details of the requested document.
Error Codes:
None
Example:
Method: GET
/api/v1/PersonDocuments/:id/get
Headers
| Content-Type | Value |
|---|---|
| Accept-Language |
Headers
| Content-Type | Value |
|---|---|
| Accept | text/plain |
Response: 200
{
"succeeded": `<boolean>`,
"message": `<string>`,
"errors": [
`<string>`,
`<string>`
],
"data": {
"id": `<uuid>`,
"personId": `<uuid>`,
"type": 2,
"path": `<string>`,
"fileName": `<string>`,
"documentNumber": `<string>`,
"approved": `<boolean>`
}
}
LANGUAGE
CURL REQUEST
curl --request GET \
--url /api/v{version}/PersonDocuments/{id}/get \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!